using System;
using System.Collections;
using System.Collections.Specialized;
using System.Data;
using System.Data.SqlTypes;
using System.Data.SqlClient;
using System.Text;
using ECommerce.DAL;


namespace Entity
{
    /// <summary>
    /// This object represents the Private Fields of TblCreditCard.
    /// </summary>

    [System.ComponentModel.DataObject]
    public class TblCreditCard : DatabaseUtility
    {
        #region TblCreditCard Private Fields


        Int32 _cardId;
        String _cardType = String.Empty;
        String _cardNumber = String.Empty;
        String _cardCode = String.Empty;
        DateTime _expireDate;

        #endregion
        #region TblCreditCard Constractor
        /// <summary>
        /// Creates an empty object of TblCreditCard. 
        /// This is mainly used to create a new instance of TblCreditCard to add a new TblCreditCard.
        /// </summary>
        public TblCreditCard() { }


        /// <summary>
        /// Used to retrieve employee information from database, 
        /// which is also used by Update method to save information of an existing TblCreditCard.
        /// </summary>
        public TblCreditCard
        (
            Int32 cardId,
            String cardType,
            String cardNumber,
            String cardCode,
            DateTime expireDate
        )
        {
            _cardId = cardId;
            _cardType = cardType;
            _cardNumber = cardNumber;
            _cardCode = cardCode;
            _expireDate = expireDate;
        }

        #endregion
        #region TblCreditCard Properties

        /***********************************************************************************************
                                    -- PROPERTIES --        
         Contains all the properties representing the data fields of the current entity.
         ***********************************************************************************************/

        /// <summary>
        /// This is the Primary key value of the CardId, which can't be assigned from the application,
        /// to ensure the data consistancy, by not letting the user to change the PK_TblCreditCard to update the data of an another TblCreditCard instance.
        /// For view or updation purpose, every TblCreditCard will be retrieved thru the proper 'Get' method.
        /// </summary>

        public Int32 CardId
        {
            get { return _cardId; }
        }


        public String CardType
        {
            get { return _cardType; }
            set { _cardType = value; }
        }

        public String CardNumber
        {
            get { return _cardNumber; }
            set { _cardNumber = value; }
        }

        public String CardCode
        {
            get { return _cardCode; }
            set { _cardCode = value; }
        }

        public DateTime ExpireDate
        {
            get { return _expireDate; }
            set { _expireDate = value; }
        }


        #endregion
        #region TblCreditCard Static Methods
        /************************************************************************************
                                    -- CREATE METHOD (STATIC) --
        *************************************************************************************/
        /************************* Architecure note:**********************************
        Note 1:
        This method is specially useful for the case, where we need to use Object Data Source controls.
        For ObjectDataSource/SqlDataSource controls, the insert/update metnod requires paramters methods, rather property based methods.
        However, there is still a way to pass property based objects as method parameter for data source controls, 
        but in that case we could not use Sql type, as view controls or asp parameter control can only contain few of primitive type.
        The main reason to remain the Sql Type in our object architecture is it is faster and contains better way for null value support.
        
        Note 2: 
        Non-primary key: it should be primitive type, as the asp paramter control (included in data source control) supports only primitive types.
        /*****************************************************************************/
        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Insert, true)]
        public static Int32 CreateNewTblCreditCard
        (
            String cardType,
            String cardNumber,
            String cardCode,
            DateTime expireDate
        )
        {
            //creating an empty TblCreditCard object
            TblCreditCard tblCreditCard = new TblCreditCard();
            tblCreditCard.CardType = cardType;
            tblCreditCard.CardNumber = cardNumber;
            tblCreditCard.CardCode = cardCode;
            tblCreditCard.ExpireDate = expireDate;

            return TblCreditCard.CreateNewTblCreditCard(tblCreditCard);
        }

        /************************************************************************************
                 -- UPDATE METHODS (STATIC) --
        *************************************************************************************/

        /************************* Architecure note:**********************************
        Note 1:
        This method is specially useful for the case, where we need to use Object Data Source controls.
        For ObjectDataSource/SqlDataSource controls, the insert/update metnod requires paramters methods, rather property based methods.
        However, there is still a way to pass property based objects as method parameter for data source controls, 
        but in that case we could not use Sql type, as view controls or asp parameter control can only contain few of primitive type.
        The main reason to remain the Sql Type in our object architecture is it is faster and contains better way for null value support.
        
        Note 2: 
        There the two types of paramaters will be passed here.
         * a. Primary key paramater: it should be Sql type, as we will bind the primary key property for the view controls (form view, details view etc) as datakey.
         * b. Non-primary key: it should be primitive type, as the asp paramter control (included in data source control) supports only primitive types.
        /*****************************************************************************/

        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Update, true)]
        public static bool UpdateTblCreditCard
        (
            Int32 cardId,
            String cardType,
            String cardNumber,
            String cardCode,
            DateTime expireDate
        )
        {
            TblCreditCard tblCreditCard = TblCreditCard.GetTblCreditCardByCardId(cardId);

            tblCreditCard.CardType = cardType;
            tblCreditCard.CardNumber = cardNumber;
            tblCreditCard.CardCode = cardCode;
            tblCreditCard.ExpireDate = expireDate;

            return TblCreditCard.UpdateTblCreditCard(tblCreditCard);
        }

        /************************************************************************************
                         -- DELETE METHODS --
        *************************************************************************************/
        /************************* Architecure note:**********************************
        We have used the employeeId parameter as SqlInt32, to bind the delete method with object data source and view control directly.
        ****************************************************************************/
        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Update, true)]
        public static bool DeleteTblCreditCard
        (
            Int32 cardId
        )
        {
            //Validate Input
            if (cardId <= GetCardIdMinValue)
                throw (new ArgumentOutOfRangeException("cardId"));

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            AddParameterToSqlCmd(sqlCmd, "@ReturnValue", SqlDbType.Int, 0, ParameterDirection.ReturnValue, null);
            AddParameterToSqlCmd(sqlCmd, "@CardId", SqlDbType.Int, 0, ParameterDirection.Input, cardId);
            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLCREDITCARD_DELETETBLCREDITCARD);
            ExecuteScalarCmd(sqlCmd);
            int returnValue = (int)sqlCmd.Parameters["@ReturnValue"].Value;
            return (returnValue == 0 ? false : true);

        }

        /// <summary>
        /// Deletes a set of employees from the database.
        /// </summary>
        public static bool DeleteTblCreditCardList(System.Collections.Generic.List<Int32> cardIdListToDelete)
        {
            //Validate Input
            foreach (Int32 cardId in cardIdListToDelete)
                if (cardId <= GetCardIdMinValue)
                    throw (new ArgumentOutOfRangeException("cardId"));

            //performing deletion operation //

            string xmlString = FormatXMLForIdArray(cardIdListToDelete);

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            AddParameterToSqlCmd(sqlCmd, "@ReturnValue", SqlDbType.Int, 0, ParameterDirection.ReturnValue, null);
            AddParameterToSqlCmd(sqlCmd, "@CardIdList", SqlDbType.Xml, xmlString.ToString().Length, ParameterDirection.Input, xmlString.ToString());
            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLCREDITCARD_DELETETBLCREDITCARDLIST);
            ExecuteScalarCmd(sqlCmd);
            int returnValue = (int)sqlCmd.Parameters["@ReturnValue"].Value;
            return (returnValue == cardIdListToDelete.Count ? true : false);
        }

        /************************************************************************************
                                 -- GET BY PRIMARY METHODS --
        *************************************************************************************/
        /************************* Architecure note:**********************************
        Retrives an Employee from database, based on it's primary key.
        To view or update an employee, everytime we must have to use this type of 'get' method, 
        since we don't have direct access to the Primary key value for assigning value.
        We have used the employeeId parameter as SqlInt32, to bind the delete method with object data source and view control directly.
        /*****************************************************************************/
        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Select, true)]
        public static TblCreditCard GetTblCreditCardByCardId(Int32 cardId)
        {
            if (cardId <= GetCardIdMinValue)
                throw (new ArgumentOutOfRangeException("cardId"));

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            AddParameterToSqlCmd(sqlCmd, "@CardId", SqlDbType.Int, 0, ParameterDirection.Input, cardId);
            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLCREDITCARD_GETTBLCREDITCARDBYCARDID);
            GenerateCollectionFromReader test = new GenerateCollectionFromReader(GenerateTblCreditCardCollectionFromReader);
            CustomCollection<TblCreditCard> objCollection = ((CustomCollection<TblCreditCard>)ExecuteReaderCmd(sqlCmd, test));

            if (objCollection.Count > 0)
                return objCollection[0];
            else
                return null;
        }

        /************************************************************************************
                         -- GET BY FOREIGN KEY METHODS --
        *************************************************************************************/

        /************************************************************************************
                 -- GET ALL METHODS --
        *************************************************************************************/
        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Select, true)]
        public static CustomCollection<TblCreditCard> GetAllTblCreditCard()
        {

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLCREDITCARD_GETALLTBLCREDITCARD);
            GenerateCollectionFromReader test = new GenerateCollectionFromReader(GenerateTblCreditCardCollectionFromReader);
            CustomCollection<TblCreditCard> objCollection = ((CustomCollection<TblCreditCard>)ExecuteReaderCmd(sqlCmd, test));

            return objCollection;
        }

        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Select, true)]
        public static CustomCollection<TblCreditCard> GetAllTblCreditCardPaged(String orderBy, Int32 startRowIndex, Int32 maximumRows)
        {
            //Validate Input
            if (orderBy == "")
                orderBy = "CardId";

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            AddParameterToSqlCmd(sqlCmd, "@orderby", SqlDbType.VarChar, 50, ParameterDirection.Input, orderBy);
            AddParameterToSqlCmd(sqlCmd, "@startrow", SqlDbType.Int, 0, ParameterDirection.Input, startRowIndex);
            AddParameterToSqlCmd(sqlCmd, "@pagesize", SqlDbType.Int, 0, ParameterDirection.Input, maximumRows);

            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLCREDITCARD_GETALLTBLCREDITCARDPAGED);

            GenerateCollectionFromReader test = new GenerateCollectionFromReader(GenerateTblCreditCardCollectionFromReader);
            CustomCollection<TblCreditCard> objCollection = ((CustomCollection<TblCreditCard>)ExecuteReaderCmd(sqlCmd, test));
            return objCollection;
        }

        [System.ComponentModel.DataObjectMethodAttribute(System.ComponentModel.DataObjectMethodType.Select, true)]
        public static int GetAllTblCreditCardPagedCount(String orderBy, Int32 startRowIndex, Int32 maximumRows)
        {
            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();

            AddParameterToSqlCmd(sqlCmd, "@ReturnValue", SqlDbType.Int, 0, ParameterDirection.ReturnValue, null);
            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLCREDITCARD_GETALLTBLCREDITCARDPAGEDCOUNT);
            ExecuteScalarCmd(sqlCmd);

            int returnValue = (int)sqlCmd.Parameters["@ReturnValue"].Value;
            return returnValue;
        }

        #endregion
        #region Employee Instance Methods
        /************************************************************************************
                                    -- SAVE (INSERT/UPDATE) METHODS (INSTANCE) --
        *************************************************************************************/
        /// <summary>
        /// Saves (inserts and updates) an Employee into database.
        /// The insertion occur if the EmployeeId conatins default value.
        /// Otherwises it updates the Employee into the database, based on the primary key value stored in EmployeeId.
        /// This technique ensures an Employee will not be updated without having a valid EmployeeId.
        /// </summary>
        public bool Save()
        {
            if (CardId <= GetCardIdMinValue)
            {
                Int32 TempId = CreateNewTblCreditCard(this);
                if (TempId > 0)
                {
                    _cardId = TempId;
                    return true;
                }
                else
                {
                    // error occurs
                    return false;
                }
            }
            else
            {	//This is a update Command
                return (UpdateTblCreditCard(this));
            }

        }

        public static Int32 CreateNewTblCreditCard(TblCreditCard newTblCreditCard)
        {
            // validate Parameters
            if (newTblCreditCard == null)
                throw (new ArgumentNullException("newTblCreditCard"));

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            int length = 0;
            AddParameterToSqlCmd(sqlCmd, "@ReturnValue", SqlDbType.Int, 0, ParameterDirection.ReturnValue, null);

            AddParameterToSqlCmd(sqlCmd, "@CardType", SqlDbType.NVarChar, 500, ParameterDirection.Input, newTblCreditCard.CardType);
            AddParameterToSqlCmd(sqlCmd, "@CardNumber", SqlDbType.NVarChar, 500, ParameterDirection.Input, newTblCreditCard.CardNumber);
            AddParameterToSqlCmd(sqlCmd, "@CardCode", SqlDbType.NVarChar, 50, ParameterDirection.Input, newTblCreditCard.CardCode);
            AddParameterToSqlCmd(sqlCmd, "@ExpireDate", SqlDbType.DateTime, 0, ParameterDirection.Input, newTblCreditCard.ExpireDate);

            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLCREDITCARD_CREATENEWTBLCREDITCARD);
            ExecuteScalarCmd(sqlCmd);
            return (Int32.Parse(sqlCmd.Parameters["@ReturnValue"].Value.ToString()));

        }
        /// <summary>
        /// Updates an TblCreditCard instance to the database.
        /// </summary>
        public static bool UpdateTblCreditCard(TblCreditCard newTblCreditCard)
        {
            // validate Parameters
            if (newTblCreditCard == null)
                throw (new ArgumentNullException("newTblCreditCard"));

            // Execute SQL Command
            SqlCommand sqlCmd = new SqlCommand();
            int length = 0;
            AddParameterToSqlCmd(sqlCmd, "@ReturnValue", SqlDbType.Int, 0, ParameterDirection.ReturnValue, null);

            AddParameterToSqlCmd(sqlCmd, "@CardId", SqlDbType.Int, 0, ParameterDirection.Input, newTblCreditCard.CardId);
            AddParameterToSqlCmd(sqlCmd, "@CardType", SqlDbType.NVarChar, 500, ParameterDirection.Input, newTblCreditCard.CardType);
            AddParameterToSqlCmd(sqlCmd, "@CardNumber", SqlDbType.NVarChar, 500, ParameterDirection.Input, newTblCreditCard.CardNumber);
            AddParameterToSqlCmd(sqlCmd, "@CardCode", SqlDbType.NVarChar, 50, ParameterDirection.Input, newTblCreditCard.CardCode);
            AddParameterToSqlCmd(sqlCmd, "@ExpireDate", SqlDbType.DateTime, 0, ParameterDirection.Input, newTblCreditCard.ExpireDate);

            SetCommandType(sqlCmd, CommandType.StoredProcedure, SP_TBLCREDITCARD_UPDATETBLCREDITCARD);
            ExecuteScalarCmd(sqlCmd);
            int returnValue = (int)sqlCmd.Parameters["@ReturnValue"].Value;
            return (returnValue == 0 ? false : true);
        }
        #endregion

        #region TblCreditCard Related Collections
        /// <summary>
        /// Creates and returns a strongly typed collection of Employee custom entity. 
        /// The colelction is created through iterating on the IdataReader object which contains Employee information, as a set of records, similar to tabular format.
        /// </summary>
        public static CollectionBase GenerateTblCreditCardCollectionFromReader(IDataReader returnData)
        {

            //creating the instance of Employee collection
            CustomCollection<TblCreditCard> colTblCreditCard = new CustomCollection<TblCreditCard>();

            /************************* Architecure note:**********************************
             * Below code includes the null value functionality to retieve the data which has nill value in database end.
             * Design consideration:
             * Besides general data fields, special care should be taken for primary keys, to assign '0'/defaultvalue, rather passing 'Null' value in constructor parameter.
             * Although we are considering sqldb tyoe data for the current data container, but while retireving data from database end, through datareader object, we need to cast data reader objects using .net primitive data type, 
             * rather using sqldb type to cast, since data reader objects don't support sql db type to be casted.
             *****************************************************************************/

            //Iterating thriugh the data reader, to generate Employee collection.

            //getting the Employee collection by iterating thru the data reader
            while (returnData.Read())
            {
                //passing the TblCreditCard constructor parameters from the current instance of data reader fields.
                TblCreditCard newTblCreditCard = new TblCreditCard
                (
                    returnData["CardId"] == System.DBNull.Value ? GetCardIdMinValue : (Int32)returnData["CardId"],
                    returnData["CardType"] == System.DBNull.Value ? string.Empty : (String)returnData["CardType"],
                    returnData["CardNumber"] == System.DBNull.Value ? string.Empty : (String)returnData["CardNumber"],
                    returnData["CardCode"] == System.DBNull.Value ? string.Empty : (String)returnData["CardCode"],
                    returnData["ExpireDate"] == System.DBNull.Value ? DateTime.MinValue : (DateTime)returnData["ExpireDate"]

                );
                //adding the Employee to the collection
                colTblCreditCard.Add(newTblCreditCard);
            }

            //returns the collection of Companys 
            return (colTblCreditCard);
        }

        #endregion
        #region Constants and Default Values

        public static Int32 GetCardIdMinValue
        {
            get
            {
                return 0;
            }
        }

        //create method related contants
        internal const string SP_TBLCREDITCARD_CREATENEWTBLCREDITCARD = "sp_TblCreditCard_CreateNewTblCreditCard";
        internal const string SP_TBLCREDITCARD_UPDATETBLCREDITCARD = "sp_TblCreditCard_UpdateTblCreditCard";
        internal const string SP_TBLCREDITCARD_DELETETBLCREDITCARD = "sp_TblCreditCard_DeleteTblCreditCard";
        internal const string SP_TBLCREDITCARD_DELETETBLCREDITCARDLIST = "sp_TblCreditCard_DeleteTblCreditCardList";
        internal const string SP_TBLCREDITCARD_GETTBLCREDITCARDBYCARDID = "sp_TblCreditCard_GetTblCreditCardByCardId";
        internal const string SP_TBLCREDITCARD_GETALLTBLCREDITCARD = "sp_TblCreditCard_GetAllTblCreditCard";
        internal const string SP_TBLCREDITCARD_GETALLTBLCREDITCARDPAGED = "sp_TblCreditCard_GetAllTblCreditCardPaged";
        internal const string SP_TBLCREDITCARD_GETALLTBLCREDITCARDPAGEDCOUNT = "sp_TblCreditCard_GetAllTblCreditCardPagedCount";

        #endregion
    }
}
